/*****************************************************************************
* File Name: watch_dog_timer.h
*
* Version: 1.0
*
* Description:
* This file contains API functions for configuring and clearing the Watch dog timer
*
* Note:
* Define DISABLE_WATCH_DOG in platform.h to disable watch dog timer module
*
* Owner: MRAO
*
* Related Document:
* System Reference Guide
*
* Hardware Dependency:
* PRoC BLE Family of Devices
*
* Code Tested With:
* 1. PSoC Creator 3.1 
* 2. ARM GCC 4.8.4
******************************************************************************
* Copyright (2015), Cypress Semiconductor Corporation.
******************************************************************************
* This software is owned by Cypress Semiconductor Corporation (Cypress) and is
* protected by and subject to worldwide patent protection (United States and
* foreign), United States copyright laws and international treaty provisions.
* Cypress hereby grants to licensee a personal, non-exclusive, non-transferable
* license to copy, use, modify, create derivative works of, and compile the
* Cypress Source Code and derivative works for the sole purpose of creating
* custom software in support of licensee product to be used only in conjunction
* with a Cypress integrated circuit as specified in the applicable agreement.
* Any reproduction, modification, translation, compilation, or representation of
* this software except as specified above is prohibited without the express
* written permission of Cypress.
*
* Disclaimer: CYPRESS MAKES NO WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, WITH
* REGARD TO THIS MATERIAL, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. 
* Cypress reserves the right to make changes without further notice to the
* materials described herein. Cypress does not assume any liability arising out
* of the application or use of any product or circuit described herein. Cypress
* does not authorize its products for use as critical components in life-support
* systems where a malfunction or failure may reasonably be expected to result in
* significant injury to the user. The inclusion of Cypress' product in a life-
* support systems application implies that the manufacturer assumes all risk of
* such use and in doing so indemnifies Cypress against all charges. Use may be
* limited by and subject to the applicable Cypress software license agreement.
*****************************************************************************/
#ifndef _WATCH_DOG_TIMER_H_
#define _WATCH_DOG_TIMER_H_

#include "platform.h"

#ifndef DISABLE_WATCH_DOG
/*****************************************************************************
* Function Name: Watch_Dog_Timer_Init()
******************************************************************************
* Summary:
* This function initializes the watch dog timer
*
* Parameters:
* uint32 counter0Value - counter0 number value
* uint32 counter1Value - counter1 number value
*
* Return:
* None
*
*****************************************************************************/
extern void Watch_Dog_Timer_Init(uint32 counter0Value);

/*****************************************************************************
* Function Name: Watch_Dog_Timer_Clear()
******************************************************************************
* Summary:
* This function clears the watch dog timer
*
* Parameters:
* None
*
* Return:
* None
*
*****************************************************************************/
extern void Watch_Dog_Timer_Clear(void);

/*****************************************************************************
* Function Name: Watch_Dog_Timer_Disable()
******************************************************************************
* Summary:
* This function disables the watch dog timer
*
* Parameters:
* None
*
* Return:
* None
*
*****************************************************************************/
extern void Watch_Dog_Timer_Disable(void);

/*****************************************************************************
* Function Name: Watch_Dog_Timer_Enable()
******************************************************************************
* Summary:
* This function enables the watch dog timer
*
* Parameters:
* None
*
* Return:
* None
*
*****************************************************************************/
extern void Watch_Dog_Timer_Enable(void);
#else
#define Watch_Dog_Timer_Clear()
#define Watch_Dog_Timer_Disable()
#define Watch_Dog_Timer_Enable()
#define Watch_Dog_Timer_Init(counter0Value)

#endif /* DISABLE_WATCH_DOG */

#endif /* _WATCH_DOG_TIMER_H_ */
